/*
 * Licensed to GraphHopper GmbH under one or more contributor
 * license agreements. See the NOTICE file distributed with this work for
 * additional information regarding copyright ownership.
 *
 * GraphHopper GmbH licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.graphhopper.jsprit.core.algorithm.ruin;

import com.graphhopper.jsprit.core.problem.job.Job;

import java.util.Iterator;

/**
 * 任务的邻结点
 * Created by schroeder on 07/01/15.
 */
public interface JobNeighborhoods {

    /**
     * 获取neighborTo任务的最近的nNeighbors个邻结点的迭代器
     *
     * @param nNeighbors 这个不知道干嘛的
     * @param neighborTo 任务
     * @return
     */
    public Iterator<Job> getNearestNeighborsIterator(int nNeighbors, Job neighborTo);

    /**
     * 初始化邻结点数组
     */
    public void initialise();

    /**
     * 获取最大距离
     *
     * @return
     */
    public double getMaxDistance();

}
